home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / cher2.z / cher2
Encoding:
Text File  |  2002-10-03  |  15.4 KB  |  331 lines

  1.  
  2.  
  3.  
  4. CCCCHHHHEEEERRRR2222((((3333SSSS))))                                                            CCCCHHHHEEEERRRR2222((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CCCCHHHHEEEERRRR2222, ZZZZHHHHEEEERRRR2222 - Performs Hermitian rank 2 update of a complex Hermitian
  10.      matrix
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      Single precision complex
  14.  
  15.           Fortran:
  16.                CCCCAAAALLLLLLLL CCCCHHHHEEEERRRR2222 ((((_u_p_l_o,,,, _n,,,, _a_l_p_h_a,,,, _x,,,, _i_n_c_x,,,, _y,,,, _i_n_c_y,,,, _a,,,, _l_d_a))))
  17.  
  18.           C/C++:
  19.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  20.                vvvvooooiiiidddd cccchhhheeeerrrr2222 ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_a_l_p_h_a,,,,
  21.                ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_y,,,, iiiinnnntttt _i_n_c_y,,,,
  22.                ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_a,,,, iiiinnnntttt _l_d_a))));;;;
  23.  
  24.           C++ STL:
  25.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  26.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  27.                vvvvooooiiiidddd cccchhhheeeerrrr2222 ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a_l_p_h_a,,,,
  28.                ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_x,,,, iiiinnnntttt _i_n_c_x,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_y,,,, iiiinnnntttt _i_n_c_y,,,,
  29.                ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a,,,, iiiinnnntttt _l_d_a))));;;;
  30.  
  31.      Double precision complex
  32.  
  33.           Fortran:
  34.                CCCCAAAALLLLLLLL ZZZZHHHHEEEERRRR2222 ((((_u_p_l_o,,,, _n,,,, _a_l_p_h_a,,,, _x,,,, _i_n_c_x,,,, _y,,,, _i_n_c_y,,,, _a,,,, _l_d_a))))
  35.  
  36.           C/C++:
  37.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  38.                vvvvooooiiiidddd zzzzhhhheeeerrrr2222 ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_a_l_p_h_a,,,,
  39.                ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_y,,,, iiiinnnntttt _i_n_c_y,,,,
  40.                ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_a,,,, iiiinnnntttt _l_d_a))));;;;
  41.  
  42.           C++ STL:
  43.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  44.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  45.                vvvvooooiiiidddd zzzzhhhheeeerrrr2222 ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_a_l_p_h_a,,,,
  46.                ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_x,,,, iiiinnnntttt _i_n_c_x,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_y,,,, iiiinnnntttt _i_n_c_y,,,,
  47.                ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_a,,,, iiiinnnntttt _l_d_a))));;;;
  48.  
  49. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  50.      These routines are part of the SCSL Scientific Library and can be loaded
  51.      using either the ----llllssssccccssss or the ----llllssssccccssss____mmmmpppp option.  The ----llllssssccccssss____mmmmpppp option
  52.      directs the linker to use the multi-processor version of the library.
  53.  
  54.      When linking to SCSL with ----llllssssccccssss or ----llllssssccccssss____mmmmpppp, the default integer size is
  55.      4 bytes (32 bits). Another version of SCSL is available in which integers
  56.      are 8 bytes (64 bits).  This version allows the user access to larger
  57.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  58.      by using the ----llllssssccccssss____iiii8888 option or the ----llllssssccccssss____iiii8888____mmmmpppp option. A program may use
  59.      only one of the two versions; 4-byte integer and 8-byte integer library
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHEEEERRRR2222((((3333SSSS))))                                                            CCCCHHHHEEEERRRR2222((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      calls cannot be mixed.
  75.  
  76.      The C and C++ prototypes shown above are appropriate for the 4-byte
  77.      integer version of SCSL. When using the 8-byte integer version, the
  78.      variables of type iiiinnnntttt become lllloooonnnngggg lllloooonnnngggg and the <<<<ssssccccssssllll____bbbbllllaaaassss____iiii8888....hhhh>>>> header
  79.      file should be included.
  80.  
  81. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  82.      These routines perform the following Hermitian rank 2 operation:
  83.  
  84.           _A  <- _a_l_p_h_a _x_y_H + (complex conjugate of _a_l_p_h_a) * _y_x_H + _A
  85.  
  86.      where _a_l_p_h_a is a scalar, _x and _y are _n-element vectors, _x_H and _y_H
  87.      conjugate transposes of _x and _y, respectively, and _A is an _n-by-_n
  88.      Hermitian matrix.
  89.  
  90.      See the NOTES section of this man page for information about the
  91.      interpretation of the data types described in the following arguments.
  92.  
  93.      These routines have the following arguments:
  94.  
  95.      _u_p_l_o      Character.  (input)
  96.                Specifies whether the upper or lower triangular part of array _a
  97.                is referenced, as follows:
  98.  
  99.                _u_p_l_o= 'U' or 'u': only the upper triangular part of _a is
  100.                referenced.
  101.                _u_p_l_o= 'L' or 'l': only the lower triangular part of _a is
  102.                referenced.
  103.  
  104.                For C/C++, a pointer to this character is passed.
  105.  
  106.      _n         Integer.  (input)
  107.                Specifies the order of matrix _A.  _n >= 0.
  108.  
  109.      _a_l_p_h_a     Scalar alpha.
  110.                CCCCHHHHEEEERRRR2222: Single precision complex.
  111.                ZZZZHHHHEEEERRRR2222: Double precision complex.
  112.  
  113.                For C/C++, a pointer to this scalar is passed.
  114.  
  115.      _x         Array of dimension 1+(_n-1) * |_i_n_c_x|.  (input)
  116.                CCCCHHHHEEEERRRR2222: Single precision complex array.
  117.                ZZZZHHHHEEEERRRR2222: Double precision complex array.
  118.                Contains vector _x.
  119.  
  120.      _i_n_c_x      Integer.  (input)
  121.                Specifies the increment for the elements of _x.  _i_n_c_x must not
  122.                be 0.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHEEEERRRR2222((((3333SSSS))))                                                            CCCCHHHHEEEERRRR2222((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      _y         Array of dimension 1+(_n-1) * |_i_n_c_y|.  (input)
  141.                CCCCHHHHEEEERRRR2222: Single precision complex array.
  142.                ZZZZHHHHEEEERRRR2222: Double precision complex array.
  143.                Contains vector _y.
  144.  
  145.      _i_n_c_y      Integer.  (input)
  146.                Specifies the increment for the elements of _y.  _i_n_c_y must not
  147.                be 0.
  148.  
  149.      _a         Array of dimension (_l_d_a,_n).  (input and output)
  150.                CCCCHHHHEEEERRRR2222: Single precision complex array.
  151.                ZZZZHHHHEEEERRRR2222: Double precision complex array.
  152.  
  153.                Before entry with _u_p_l_o = 'U' or 'u', the leading _n-by-_n upper
  154.                triangular part of array _a must contain the upper triangular
  155.                part of the Hermitian matrix.  The strictly lower triangular
  156.                part of _a is not referenced.  On exit, the upper triangular
  157.                part of the updated matrix overwrites the upper triangular part
  158.                of array _a.
  159.  
  160.                Before entry with _u_p_l_o = 'L' or 'l', the leading _n-by-_n lower
  161.                triangular part of array _a must contain the lower triangular
  162.                part of the Hermitian matrix.  The strictly upper triangular
  163.                part of _a is not referenced.  On exit, the lower triangular
  164.                part of the updated matrix overwrites the lower triangular part
  165.                of array _a.
  166.  
  167.                The imaginary parts of the diagonal elements need not be set.
  168.                They are assumed to be 0; on exit, they are set to 0.
  169.  
  170.      _l_d_a       Integer.  (input)
  171.                Specifies the first dimension of _a as declared in the calling
  172.                program.  _l_d_a >= MMMMAAAAXXXX(1,_n).
  173.  
  174. NNNNOOOOTTTTEEEESSSS
  175.      CCCCHHHHEEEERRRR2222/ZZZZHHHHEEEERRRR2222 is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).
  176.  
  177.      When working backward (_i_n_c_x < 0 or _i_n_c_y < 0), this routine starts at the
  178.      end of the vector and moves backward, as follows:
  179.  
  180.           _x(1-_i_n_c_x * (_n-1)), _x(1-_i_n_c_x * (_n-2)) , ..., _x(1)
  181.  
  182.           _y(1-_i_n_c_y * (_n-1)), _y(1-_i_n_c_y * (_n-2)) , ..., _y(1)
  183.  
  184.  
  185.    DDDDaaaattttaaaa TTTTyyyyppppeeeessss
  186.      The following data types are described in this documentation:
  187.  
  188.           TTTTeeeerrrrmmmm UUUUsssseeeedddd                     DDDDaaaattttaaaa ttttyyyyppppeeee
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CCCCHHHHEEEERRRR2222((((3333SSSS))))                                                            CCCCHHHHEEEERRRR2222((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      Fortran:
  207.  
  208.           Array dimensioned _n           xxxx((((nnnn))))
  209.  
  210.           Array of dimensions (_m,_n)     xxxx((((mmmm,,,,nnnn))))
  211.  
  212.           Character                     CCCCHHHHAAAARRRRAAAACCCCTTTTEEEERRRR
  213.  
  214.           Integer                       IIIINNNNTTTTEEEEGGGGEEEERRRR (IIIINNNNTTTTEEEEGGGGEEEERRRR****8888 for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  215.  
  216.           Single precision complex      CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  217.  
  218.           Double precision complex      DDDDOOOOUUUUBBBBLLLLEEEE CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  219.  
  220.      C/C++:
  221.  
  222.           Array dimensioned _n           xxxx[[[[_n]]]]
  223.  
  224.           Array of dimensions (_m, _n)    xxxx[[[[mmmm****nnnn]]]]
  225.  
  226.           Character                     cccchhhhaaaarrrr
  227.  
  228.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  229.  
  230.           Single precision complex      ssssccccssssllll____ccccoooommmmpppplllleeeexxxx
  231.  
  232.           Double precision complex      ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx
  233.  
  234.      C++ STL:
  235.  
  236.           Array dimensioned _n           xxxx[[[[_n]]]]
  237.  
  238.           Array of dimensions (_m, _n)    xxxx[[[[mmmm****nnnn]]]]
  239.  
  240.           Character                     cccchhhhaaaarrrr
  241.  
  242.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  243.  
  244.           Single precision complex      ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>
  245.  
  246.           Double precision complex      ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>>
  247.  
  248.      Note that you can explicitly declare multidimensional C/C++ arrays
  249.      provided that the array dimensions are swapped with respect to the
  250.      Fortran declaration (e.g., xxxx[[[[nnnn]]]][[[[mmmm]]]] in C/C++ versus xxxx((((mmmm,,,,nnnn)))) in Fortran).
  251.      To avoid a compiler type mismatch error in C++ (or a compiler warning
  252.      message in C), however, the array should be cast to a pointer of the
  253.      appropriate type when passed as an argument to a SCSL routine.
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. CCCCHHHHEEEERRRR2222((((3333SSSS))))                                                            CCCCHHHHEEEERRRR2222((((3333SSSS))))
  269.  
  270.  
  271.  
  272. SEE ALSO
  273.      IIIINNNNTTTTRRRROOOO____SSSSCCCCSSSSLLLL(3S), IIIINNNNTTTTRRRROOOO____BBBBLLLLAAAASSSS2222(3S), SSSSSSSSYYYYRRRR2222(3S)
  274.  
  275.      IIIINNNNTTTTRRRROOOO____CCCCBBBBLLLLAAAASSSS(3S) for information about using the C interface to Fortran 77
  276.      Basic Linear Algebra Subprograms (legacy BLAS) set forth by the Basic
  277.      Linear Algebra Subprograms Technical Forum.
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.                                                                         PPPPaaaaggggeeee 5555
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.